home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / etc / Misc_InvokeEditor.man < prev    next >
Encoding:
Text File  |  1991-06-04  |  1.3 KB  |  44 lines
  1. '\" Copyright 1991 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/lib/c/etc/RCS/InvokeEditor.man,v 1.1 91/06/04 16:32:02 kupfer Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS Misc lib
  13. .BS
  14. '\" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. Misc_InvokeEditor \- Invoke an editor for a user
  17. .SH SYNOPSIS
  18. .nf
  19. \fB#include <libc.h>\fR
  20. .sp
  21. int
  22. \fBMisc_InvokeEditor\fR(\fIfile\fP)
  23. .SH ARGUMENTS
  24. .AS char *file
  25. .AP char *file in
  26. Name of the file to edit.
  27. .BE
  28.  
  29. .SH DESCRIPTION
  30. .PP
  31. If a program needs to have the user edit a file, it can simply call 
  32. .B Misc_InvokeEditor
  33. with the name of the file to edit.  The user's editor (as defined by
  34. the EDITOR environment variable, with
  35. .B vi
  36. being the default) will be invoked.  
  37. .B Misc_InvokeEditor
  38. returns the exit status from the editor.  For setuid and setgid
  39. programs, the editor is invoked with the user's real (not effective)
  40. user and group IDs.
  41.  
  42. .SH KEYWORDS
  43. edit, file
  44.